/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.netbeans.modules.editor.settings.storage.spi;

import java.io.IOException;
import java.util.Map;
import java.util.concurrent.Callable;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.netbeans.api.editor.mimelookup.MimePath;

/**
 *
 * TODO: describe threading, possible storageDescription IDs, semantics of filtering 
 *       after load and 'un-filtering' before save
 * 
 * @author vita
 */
public abstract class StorageFilter<K extends Object, V extends Object> {

    protected StorageFilter(String storageDescriptionId) {
        this.storageDescriptionId = storageDescriptionId;
    }
    
    public abstract void afterLoad(Map<K, V> map, MimePath mimePath, String profile, boolean defaults) throws IOException;
    public abstract void beforeSave(Map<K, V> map, MimePath mimePath, String profile, boolean defaults) throws IOException;
    
    protected final void notifyChanges() {
        assert notificationCallback != null;
        try {
            notificationCallback.call();
        } catch (Exception ex) {
            LOG.log(Level.WARNING, null, ex);
        }
    }
    
    // ----------------------------------------------------------------------
    // Package private implementation
    // ----------------------------------------------------------------------

    /* package */ final void initialize(Callable<?> notificationCallback) {
        this.notificationCallback = notificationCallback;
    }
    
    /* package */ final String getStorageDescriptionId() {
        return storageDescriptionId;
    }
    
    // ----------------------------------------------------------------------
    // Private implementation
    // ----------------------------------------------------------------------
    
    private static final Logger LOG = Logger.getLogger(StorageFilter.class.getName());
    private final String storageDescriptionId;
    private Callable<?> notificationCallback;
}
